<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home In Manchester</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description_mc" content="">
<meta name="author" content="">

<!-- Le styles -->
<link href="assets/css/bootstrap.css" rel="stylesheet">
<link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
<link href="assets/css/docs.css" rel="stylesheet">
<link href="assets/js/google-code-prettify/prettify.css"
	rel="stylesheet">

<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
      <script src="assets/js/html5shiv.js"></script>
    <![endif]-->

<style>
body {
	font-family: 微软雅黑;
	font-size: 14px;
}

.nav-list {
	margin-top: 0px;
}

h4 {
	margin-top: 25px;
}
</style>
</head>

<body data-spy="scroll" data-target=".bs-docs-sidebar">

	<!-- Navbar
    ================================================== -->
	<div class="navbar navbar-inverse navbar-fixed-top">
		<div class="navbar-inner">
			<div class="container">
				<button type="button" class="btn btn-navbar" data-toggle="collapse"
					data-target=".nav-collapse">
					<span class="icon-bar"></span> <span class="icon-bar"></span> <span
						class="icon-bar"></span>
				</button>
				<div class="nav-collapse collapse">
					<ul class="nav">
						<li class=""><a href="index.html">首页</a></li>
						<li class=""><a href="live.html">生活信息</a></li>
						<li class=""><a href="func.html">实用功能</a></li>
						<li class=""><a href="forum.html">娱乐交友</a></li>
						<li class=""><a href="study.html">学术讨论</a></li>
						<li class=""><a href="member.html">会员管理</a></li>
						<li class=""><a href="bookFood.html">订餐系统</a></li>
						<li class=""><a href="ticket.html">票务系统</a></li>
						<li class=""><a href="coupon.html">优惠券</a></li>
						<li class=""><a href="readme.html">补充说明</a></li>
						<li class=""><a href="extend.html">扩展功能</a></li>
						<li class="active"><a href="advert.html">广告</a></li>
						<li class=""><a href="report.html">公告系统</a></li>
						<li class=""><a href="radio.html">电台系统</a></li>
					</ul>
				</div>
			</div>
		</div>
	</div>

	<!-- Subhead
================================================== -->
	<header class="jumbotron subhead" id="overview">
		<div class="container">
			<h1>客户端接口调用指南</h1>
			<p class="lead">web客户端、移动客户端获取和设置服务器数据的统一接口访问规范。符合restful的api设计范式，提供跨平台的基于http协议的一致web接口。</p>
		</div>
	</header>


	<div class="container">

		<!-- Docs nav
    ================================================== -->
		<div class="row">
			<div class="span3 bs-docs-sidebar">
				<h3>系统广告API</h3>
				<ul class="nav nav-list bs-docs-sidenav">
					<li><a href="#getOpenAdverts"><i class="icon-chevron-right"></i>
							获取开机广告</a></li>
					<li><a href="#getIndexAdverts"><i class="icon-chevron-right"></i>
							获取首页广告</a></li>
					<li><a href="#getListAdverts"><i class="icon-chevron-right"></i>
							获取列表页广告</a></li>
					<li><a href="#getContentAdverts"><i class="icon-chevron-right"></i>
							获取内容广告</a></li>
					<li><a href="#text"><i class="icon-chevron-right"></i>
							链接广告跳转说明</a></li>
					
				</ul>
				
				
			</div>
			<div class="span9">

				<!-- Typography
        ================================================== -->
				

				<!-- Code
        ================================================== -->
				<section id="getOpenAdverts">
					<div class="page-header">
						<h1>获取APP启动广告API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>当APP客户端应用启动的时候，调用的广告信息来自该接口。通过点击广告，可以连接到相关的栏目信息页。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/advert/start</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/advert/start</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。无。</p>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/advert/start</code>

					<h4>2.6 返回参数说明</h4>
					<p>请求成功，会返回商家的列表信息。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>status</td>
								<td>Integer</td>
								<td>是否启用状态。0标示未启用，不会显示出来；1标示已启用，可以显示。</td>
							</tr>
							<tr>
								<td>type</td>
								<td>Integer</td>
								<td>广告类型。0标示列表页广告；1标示开机广告；2标示首页广告。</td>
							</tr>
							<tr>
								<td>adId</td>
								<td>Integer</td>
								<td>广告唯一标示。</td>
							</tr>
							<tr>
								<td>adPos</td>
								<td>Integer</td>
								<td>广告位置。0标示置顶；1标示全屏。</td>
							</tr>
							<tr>
								<td>adType</td>
								<td>Integer</td>
								<td>广告展现形式。0标示图片；1标示gif动图；2标示视频。</td>
							</tr>
							<tr>
								<td>moduleType</td>
								<td>Integer</td>
								<td>模块类型。系统共有八大模块，具体参考《扩展模块》中<a href="extend.html#moduleType">模块类型</a></td>
							</tr>
							<tr>
								<td>moduleId</td>
								<td>Long</td>
								<td>模块唯一标示。</td>
							</tr>
							<tr>
								<td>adContent</td>
								<td>String</td>
								<td>广告内容。一般来说为图片，如：xxx.jpg；或者为动图或者视频，如：xxx.gif。系统访问还需要加上前缀：http://115.29.250.136:8080/resources/fileupload/</td>
							</tr>
							<tr>
								<td>adDesc</td>
								<td>String</td>
								<td>广告说明。</td>
							</tr>
						</tbody>
					</table>
					

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：无。</p>
					

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/advert/start</code>
					<pre>

  [
    {
        "adContent": "1514a2e2-d8f4-4d70-8de7-f5e829189585.jpg", 
        "moduleType": 1, 
        "moduleId": 77, 
        "adId": 4, 
        "adPos": 1, 
        "adType": 0, 
        "adDesc": null, 
        "type": 1, 
        "status": 1
    }, 
    {
        "adContent": "cf30902c-292d-4b37-84c9-f05cbfea8179.jpg", 
        "moduleType": 6, 
        "moduleId": 10, 
        "adId": 9, 
        "adPos": 1, 
        "adType": 0, 
        "adDesc": null, 
        "type": 1, 
        "status": 1
    }, 
    {
        "adContent": "e7631dd1-f769-4f59-8e5c-fec7242baf07.jpg", 
        "moduleType": 5, 
        "moduleId": 14, 
        "adId": 11, 
        "adPos": 0, 
        "adType": 0, 
        "adDesc": null, 
        "type": 1, 
        "status": 1
    }
]
						</pre>


				</section>
				
				<section id="getIndexAdverts">
					<div class="page-header">
						<h1>获取APP首页广告API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>APP客户端应用首页广告。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/advert/index</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/advert/index</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。无。</p>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/advert/index</code>

					<h4>2.6 返回参数说明</h4>
					<p>请求成功，会返回商家的列表信息。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>status</td>
								<td>Integer</td>
								<td>是否启用状态。0标示未启用，不会显示出来；1标示已启用，可以显示。</td>
							</tr>
							<tr>
								<td>type</td>
								<td>Integer</td>
								<td>广告类型。0标示列表页广告；1标示开机广告；2标示首页广告。</td>
							</tr>
							<tr>
								<td>adId</td>
								<td>Integer</td>
								<td>广告唯一标示。</td>
							</tr>
							<tr>
								<td>adPos</td>
								<td>Integer</td>
								<td>广告位置。0标示置顶；1标示全屏。</td>
							</tr>
							<tr>
								<td>adType</td>
								<td>Integer</td>
								<td>广告展现形式。0标示图片；1标示gif动图；2标示视频。</td>
							</tr>
							<tr>
								<td>moduleType</td>
								<td>Integer</td>
								<td>模块类型。系统共有八大模块，具体参考《扩展模块》中<a href="extend.html#moduleType">模块类型</a></td>
							</tr>
							<tr>
								<td>moduleId</td>
								<td>Long</td>
								<td>模块唯一标示。</td>
							</tr>
							<tr>
								<td>adContent</td>
								<td>String</td>
								<td>广告内容。一般来说为图片，如：xxx.jpg；或者为动图或者视频，如：xxx.gif。系统访问还需要加上前缀：http://115.29.250.136:8080/resources/fileupload/</td>
							</tr>
							<tr>
								<td>adDesc</td>
								<td>String</td>
								<td>广告说明。</td>
							</tr>
						</tbody>
					</table>
					

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：无。</p>
					

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/advert/index</code>
					<pre>
[
    {
        "adContent": "97b89286-4bf5-47a9-9e62-acab385e3b08.jpg", 
        "moduleType": 1, 
        "moduleId": 78, 
        "adId": 5, 
        "adPos": 0, 
        "adType": 0, 
        "adDesc": null, 
        "type": 2, 
        "status": 1
    }
]
				</pre>


				</section>
				
				<section id="getListAdverts">
					<div class="page-header">
						<h1>获取APP列表页广告API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>APP客户端应用首页广告。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/advert/list</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/advert/list</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>是否必填</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>moduleType</td>
								<td>Integer</td>
								<td>必填</td>
								<td>模块类型。系统共有八大模块，具体参考《扩展模块》中<a href="extend.html#moduleType">模块类型</a></td>
							</tr>
						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/advert/list?moduleType=8</code>

					<h4>2.6 返回参数说明</h4>
					<p>请求成功，会返回商家的列表信息。</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>status</td>
								<td>Integer</td>
								<td>是否启用状态。0标示未启用，不会显示出来；1标示已启用，可以显示。</td>
							</tr>
							<tr>
								<td>type</td>
								<td>Integer</td>
								<td>广告类型。0标示列表页广告；1标示开机广告；2标示首页广告。</td>
							</tr>
							<tr>
								<td>adId</td>
								<td>Integer</td>
								<td>广告唯一标示。</td>
							</tr>
							<tr>
								<td>adPos</td>
								<td>Integer</td>
								<td>广告位置。0标示置顶；1标示全屏。</td>
							</tr>
							<tr>
								<td>adType</td>
								<td>Integer</td>
								<td>广告展现形式。0标示图片；1标示gif动图；2标示视频。</td>
							</tr>
							<tr>
								<td>moduleType</td>
								<td>Integer</td>
								<td>模块类型。系统共有八大模块，具体参考《扩展模块》中<a href="extend.html#moduleType">模块类型</a></td>
							</tr>
							<tr>
								<td>moduleId</td>
								<td>Long</td>
								<td>模块唯一标示。</td>
							</tr>
							<tr>
								<td>adContent</td>
								<td>String</td>
								<td>广告内容。一般来说为图片，如：xxx.jpg；或者为动图或者视频，如：xxx.gif。系统访问还需要加上前缀：http://115.29.250.136:8080/resources/fileupload/</td>
							</tr>
							<tr>
								<td>adDesc</td>
								<td>String</td>
								<td>广告说明。</td>
							</tr>
						</tbody>
					</table>
					

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：无。</p>
					

					<h4>2.8 正确返回示例：</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/advert/list?moduleType=8</code>
					<pre>
[
    {
        "adContent": "f58d9cfc-58ea-4868-a8ab-73aa62d9dc7a.jpg", 
        "moduleType": 8, 
        "moduleId": 28, 
        "adId": 18, 
        "adPos": 0, 
        "adType": 0, 
        "adDesc": null, 
        "type": 0, 
        "status": 1
    }, 
    {
        "adContent": "dea9581b-7204-4c1b-b334-777a9bd48c72.jpg", 
        "moduleType": 8, 
        "moduleId": 8, 
        "adId": 19, 
        "adPos": 0, 
        "adType": 0, 
        "adDesc": null, 
        "type": 0, 
        "status": 1
    }
]
				</pre>


				</section>
				
				<section id="getContentAdverts">
					<div class="page-header">
						<h1>获取内容页广告</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>内容页广告均为多张图片，没有连接。所有的内容广告均来自模块本身的某个属性，具体可以查看相关模块的API。具体参考如下列表所示：</p>

					
					<table class="table table-bordered">
						<thead>
							<tr>
								<th>模块名称</th>
								<th>栏目名</th>
								<th>参考API链接</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>商户内容展示广告</td>
								<td>生活信息</td>
								<td><a href="live.html#info">获取某个信息API</a>,<a href="live.html#function">功能分类信息描述</a>,此处商户为信息分类功能码funCode所标识的地址类信息。</td>
							</tr>
							<tr>
								<td>特殊类展示广告</td>
								<td>优惠券</td>
								<td><a href="coupon.html#getCoupons">查询优惠券信息</a>,优惠券信息中的pictures属性标识了该内容页的广告属性。</td>
							</tr>
							<tr>
								<td>特殊类展示广告</td>
								<td>票务</td>
								<td><a href="ticket.html#getTickets">查询票务信息列表</a>,票务信息中的images属性标识了该内容页的广告属性。</td>
							</tr>
							<tr>
								<td>特殊类展示广告</td>
								<td>跳蚤市场（实用功能-二手物品）</td>
								<td><a href="func.html#secondary_list">获取二手物品信息</a>,二手物品信息中的images属性标识了该内容页的广告属性。</td>
							</tr>
							<tr>
								<td>特殊类展示广告</td>
								<td>住在曼城（实用功能-租房信息）</td>
								<td><a href="func.html#rent_list">获取租房信息列表</a>,租房信息中的images属性标识了该内容页的广告属性。</td>
							</tr>
							<tr>
								<td>特殊类展示广告</td>
								<td>约（娱乐交友-约）</td>
								<td><a href="forum.html#posts">获取约（主题）信息列表</a>,主题信息中的images属性标识了该内容页的广告属性。</td>
							</tr>
						</tbody>
					</table>
					

					


				</section>
				
				<section id="text">
					<div class="page-header">
						<h1>链接广告并跳转</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>当用户点击广告时，要跳转到具体的功能页面。这里就需要根据moduleId和moduleType来区分到底要跳转到哪个模块以及哪个具体的信息页面去。
					例如：首页上共置顶显示了5个广告图片，他们分别可能来自商户列表（地址类信息）、优惠券、跳蚤市场等等。这时候单击时，客户端就需要根据moduleType
					来区分模块，然后根据moduleId进入到具体的内容条目中去。moduleType参考<a href="extend.html#moduleType">模块类型</a>
					</p>

					
					


				</section>
			</div>
		</div>

	</div>



	<!-- Footer
    ================================================== -->
	<footer class="footer">
		<div class="container">
			<p>
				Designed and built with all the love in the world by <a
					href="http://www.hcrazy.com" target="_blank">@hsmart</a>
			</p>
			<ul class="footer-links">
				<li><a href="http://www.hcrazy.com">Blog</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Issues</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Changelog</a></li>
			</ul>
		</div>
	</footer>



	<!-- Le javascript
    ================================================== -->
	<!-- Placed at the end of the document so the pages load faster -->
	<script src="assets/js/jquery.js"></script>
	<script src="assets/js/bootstrap-transition.js"></script>
	<script src="assets/js/bootstrap-alert.js"></script>
	<script src="assets/js/bootstrap-modal.js"></script>
	<script src="assets/js/bootstrap-dropdown.js"></script>
	<script src="assets/js/bootstrap-scrollspy.js"></script>
	<script src="assets/js/bootstrap-tab.js"></script>
	<script src="assets/js/bootstrap-tooltip.js"></script>
	<script src="assets/js/bootstrap-popover.js"></script>
	<script src="assets/js/bootstrap-button.js"></script>
	<script src="assets/js/bootstrap-collapse.js"></script>
	<script src="assets/js/bootstrap-carousel.js"></script>
	<script src="assets/js/bootstrap-typeahead.js"></script>
	<script src="assets/js/bootstrap-affix.js"></script>

	<script src="assets/js/holder/holder.js"></script>
	<script src="assets/js/google-code-prettify/prettify.js"></script>

	<script src="assets/js/application.js"></script>



</body>
</html>
